Android Barcode Scanner
Type
widget
Summary
A barcode detection widget.
Description
The barcode detection widget processes frames from the device's camera checking for barcodes. A preview of the camera will be displayed within the widget's bounds, optionally overlaying barcode data when a barcode is detected.
Multiple barcodes can be detected in a single frame. Turning the guide on will set the widget to single detect mode, with only barcodes overlapping the guide being detected.
Callbacks are sent on barcode detection and removal.
The following barcode formats are recognized:
- Aztec
- Codabar
- Code 39
- Code 93
- Code 128
- Data Matrix
- EAN 8
- EAN 13
- ITF
- PDF 417
- QR Code
- UPC A
- UPC E
Compatibility and Support
OS
android
Children Properties
Message
| Name | Summary | Syntax |
|---|---|---|
| barcodeDetected | Sent when a new barcode is detected. | barcodeDetected <pBarcode>, <pID> |
| barcodeRemoved | Sent when a barcode is no longer in the frame. | barcodeRemoved <pID> |
| barcodeClicked | Sent when a barcode has been clicked. | barcodeRemoved <pBarcode> |
Property
| Name | Summary | Syntax |
|---|---|---|
| previewWidth | The width of the camera's resolution. | get the previewWidth of <widget> set the previewWidth of <widget> to <pixels> |
| device | The camera device to use. | get the device of <widget> set the device of <widget> to "front" set the device of <widget> to "back" |
| overlayRectColor | The color of barcode rectangles. | get the overlayRectColor of <widget> set the overlayRectColor of <widget> to <color> |
| previewHeight | The height of the camera's resolution. | get the previewHeight of <widget> set the previewHeight of <widget> to <pixels> |
| snapshotMode | If and when a snapshot of a barcode should be returned. | get the snapshotMode of <widget> set the snapshotMode of <widget> to "clicked" set the snapshotMode of <widget> to "deteted" set the snapshotMode of <widget> to "never" |
| clipSnapshots | Clip returned snapshots to the rectangle of the detected barcode. | get the clipSnapshots of <widget> set the clipSnapshots of <widget> to { true | false } |
| overlayShowLabels | If barcode labels should be overlaid. | get the overlayShowLabels of <widget> set the overlayShowLabels of <widget> to { true | false } |
| overlayShowRects | If barcode rectangles should be overlaid. | get the overlayShowRects of <widget> set the overlayShowRects of <widget> to { true | false } |
| overlayShowGuide | If the barcode detection guide should be visible. | get the overlayShowGuide of <widget> set the overlayShowGuide of <widget> to { true | false } |
| acceptedFormats | The list of barcode formats to detect. | get the acceptedFormats of <widget> set the acceptedFormats of <widget> to <formatList> |
| previewFPS | The camera frame rate. | get the previewFPS of <widget> set the previewFPS of <widget> to <fps> |
| isOperational | If the widget is currently able to detect barcodes. | get the isOperational of <widget> |
| torchMode | If the device's flash light should be turned on. | get the torchMode of <widget> set the torchMode of <widget> to "auto" set the torchMode of <widget> to "on" set the torchMode of <widget> to "off" |
| overlayLabelColor | The color of the barcode labels. | get the overlayLabelColor of <widget> set the overlayLabelColor of <widget> to <color> |